<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><title>Index - Bonfire</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="IndexPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.5 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Index><div class=IPageTitle>Index</div><div class=INavigationBar><a href="General.html#Symbols">$#!</a> &middot; 0-9 &middot; <a href="General.html#A">A</a> &middot; <a href="General.html#B">B</a> &middot; <a href="General2.html#C">C</a> &middot; <a href="General3.html#D">D</a> &middot; <a href="General3.html#E">E</a> &middot; <a href="General3.html#F">F</a> &middot; <a href="General4.html#G">G</a> &middot; <a href="General4.html#H">H</a> &middot; <a href="General4.html#I">I</a> &middot; <a href="General4.html#J">J</a> &middot; <a href="General4.html#K">K</a> &middot; <a href="General4.html#L">L</a> &middot; <a href="General5.html#M">M</a> &middot; <a href="General5.html#N">N</a> &middot; <a href="General5.html#O">O</a> &middot; <a href="General5.html#P">P</a> &middot; <a href="General5.html#Q">Q</a> &middot; <a href="General5.html#R">R</a> &middot; <a href="General6.html#S">S</a> &middot; <a href="General6.html#T">T</a> &middot; <a href="#U">U</a> &middot; <a href="#V">V</a> &middot; <a href="#W">W</a> &middot; X &middot; <a href="#Y">Y</a> &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="U"></a>U</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/ui-txt.html#UI" id=link395 onMouseOver="ShowTip(event, 'tt381', 'link395')" onMouseOut="HideTip('tt381')" class=ISymbol>UI</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/auth_notes-txt.html#Understanding_Authentication" id=link396 onMouseOver="ShowTip(event, 'tt382', 'link396')" onMouseOut="HideTip('tt382')" class=ISymbol>Understanding Authentication</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>Unit Testing</span><div class=ISubIndex><a href="../files2/core_modules/tester-txt.html#Unit_Testing" id=link397 onMouseOver="ShowTip(event, 'tt383', 'link397')" onMouseOut="HideTip('tt383')" class=IFile>core_modules/<wbr>tester.txt</a><a href="../files2/general_topics/unit_testing-txt.html#Unit_Testing" id=link398 onMouseOver="ShowTip(event, 'tt383', 'link398')" onMouseOut="HideTip('tt383')" class=IFile>general_topics/<wbr>unit_testing.txt</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migration_Interface.up" id=link399 onMouseOver="ShowTip(event, 'tt384', 'link399')" onMouseOut="HideTip('tt384')" class=ISymbol>up</a>, <span class=IParent>Migration Interface</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>update</span><div class=ISubIndex><a href="../files/core/MY_Model-php.html#BF_Model.update" id=link400 onMouseOver="ShowTip(event, 'tt385', 'link400')" onMouseOut="HideTip('tt385')" class=IParent>BF_Model</a><a href="../files/core_modules/permissions/models/permission_model-php.html#Permission_model.update" id=link401 onMouseOver="ShowTip(event, 'tt386', 'link401')" onMouseOut="HideTip('tt386')" class=IParent>Permission_model</a><a href="../files/core_modules/roles/models/role_model-php.html#Role_model.update" id=link402 onMouseOver="ShowTip(event, 'tt387', 'link402')" onMouseOut="HideTip('tt387')" class=IParent>Role_model</a><a href="../files/core_modules/users/models/user_model-php.html#User_model.update" id=link403 onMouseOver="ShowTip(event, 'tt388', 'link403')" onMouseOut="HideTip('tt388')" class=IParent>User_model</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.update_where" id=link404 onMouseOver="ShowTip(event, 'tt389', 'link404')" onMouseOut="HideTip('tt389')" class=ISymbol>update_where</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/installation/upgrading-txt.html#Upgrading" id=link405 onMouseOver="ShowTip(event, 'tt390', 'link405')" onMouseOut="HideTip('tt390')" class=ISymbol>Upgrading</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.user_id" id=link406 onMouseOver="ShowTip(event, 'tt391', 'link406')" onMouseOut="HideTip('tt391')" class=ISymbol>user_id</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/models/user_model-php.html#User_model" id=link407 onMouseOver="ShowTip(event, 'tt392', 'link407')" onMouseOut="HideTip('tt392')" class=ISymbol>User_model</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.user_name" id=link408 onMouseOver="ShowTip(event, 'tt393', 'link408')" onMouseOut="HideTip('tt393')" class=ISymbol>user_name</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/libraries/auth-php.html#Auth.username" id=link409 onMouseOver="ShowTip(event, 'tt394', 'link409')" onMouseOut="HideTip('tt394')" class=ISymbol>username</a>, <span class=IParent>Auth</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/users/controllers/users-php.html#Users" id=link410 onMouseOver="ShowTip(event, 'tt395', 'link410')" onMouseOut="HideTip('tt395')" class=ISymbol>Users</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/permissions-txt.html#Using_Permissions" id=link411 onMouseOver="ShowTip(event, 'tt396', 'link411')" onMouseOut="HideTip('tt396')" class=ISymbol>Using Permissions</a></td></tr><tr><td class=IHeading><a name="V"></a>V</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/modulebuilder/controllers/developer-php.html#validate_form" id=link412 onMouseOver="ShowTip(event, 'tt397', 'link412')" onMouseOut="HideTip('tt397')" class=ISymbol>validate_form</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>Variables</span><div class=ISubIndex><a href="../files/core_modules/subnav/controllers/subnav-php.html#Variables"  class=IParent>Global</a><a href="../files/libraries/assets-php.html#Assets_Class.Variables"  class=IParent>Assets Class</a><a href="../files/core_modules/users/libraries/auth-php.html#Auth.Variables"  class=IParent>Auth</a><a href="../files/core/MY_Controller-php.html#Base_Controller.Variables"  class=IParent>Base_Controller</a><a href="../files/core/MY_Model-php.html#BF_Model.Variables"  class=IParent>BF_Model</a><a href="../files/libraries/Console-php.html#Console.Variables"  class=IParent>Console</a><a href="../files/core_modules/emailer/libraries/emailer-php.html#Emailer.Variables"  class=IParent>Emailer</a><a href="../files/libraries/events-php.html#Events_Class.Variables"  class=IParent>Events Class</a><a href="../files/core_modules/install/controllers/install-php.html#Install.Variables"  class=IParent>Install</a><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migration_Interface.Variables"  class=IParent>Migration Interface</a><a href="../files/libraries/template-php.html#Template.Variables"  class=IParent>Template</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/migrations/libraries/Migrations-php.html#Migrations_Class.version" id=link413 onMouseOver="ShowTip(event, 'tt398', 'link413')" onMouseOut="HideTip('tt398')" class=ISymbol>version</a>, <span class=IParent>Migrations Class</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core_modules/logs/controllers/developer-php.html#Logs_Developer_Context.view" id=link414 onMouseOver="ShowTip(event, 'tt399', 'link414')" onMouseOut="HideTip('tt399')" class=ISymbol>view</a>, <span class=IParent>Logs Developer Context</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/views-txt.html#View,Meet_Layout" id=link415 onMouseOver="ShowTip(event, 'tt400', 'link415')" onMouseOut="HideTip('tt400')" class=ISymbol>View,Meet Layout</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/logs-txt.html#Viewing_Logs" id=link416 onMouseOver="ShowTip(event, 'tt401', 'link416')" onMouseOut="HideTip('tt401')" class=ISymbol>Viewing Logs</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/core_modules/emailer-txt.html#Viewing_Your_Queue" id=link417 onMouseOver="ShowTip(event, 'tt402', 'link417')" onMouseOut="HideTip('tt402')" class=ISymbol>Viewing Your Queue</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/views-txt.html#Views_and_Layouts" id=link418 onMouseOver="ShowTip(event, 'tt403', 'link418')" onMouseOut="HideTip('tt403')" class=ISymbol>Views and Layouts</a></td></tr><tr><td class=IHeading><a name="W"></a>W</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/welcome-txt.html#Welcome_to_Bonfire" id=link419 onMouseOver="ShowTip(event, 'tt404', 'link419')" onMouseOut="HideTip('tt404')" class=ISymbol>Welcome to Bonfire</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/contexts-txt.html#What_are_Contexts" id=link420 onMouseOver="ShowTip(event, 'tt405', 'link420')" onMouseOut="HideTip('tt405')" class=ISymbol>What are Contexts?</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/module_overview-txt.html#What_Are_Modules" id=link421 onMouseOver="ShowTip(event, 'tt406', 'link421')" onMouseOut="HideTip('tt406')" class=ISymbol>What Are Modules?</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/core/MY_Model-php.html#BF_Model.where" id=link422 onMouseOver="ShowTip(event, 'tt407', 'link422')" onMouseOut="HideTip('tt407')" class=ISymbol>where</a>, <span class=IParent>BF_Model</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/event_hooks-txt.html#Why_Is_This_Better_Than_CI_Hooks" id=link423 onMouseOver="ShowTip(event, 'tt408', 'link423')" onMouseOut="HideTip('tt408')" class=ISymbol>Why Is This Better Than CI Hooks?</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/general_topics/event_hooks-txt.html#Why_Not_The_Database" id=link424 onMouseOver="ShowTip(event, 'tt409', 'link424')" onMouseOut="HideTip('tt409')" class=ISymbol>Why Not The Database?</a></td></tr><tr><td class=ISymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/install/controllers/install-php.html#Install.$writable_folders" id=link425 onMouseOver="ShowTip(event, 'tt410', 'link425')" onMouseOut="HideTip('tt410')" class=ISymbol>writable_folders</a>, <span class=IParent>Install</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#write_config" id=link426 onMouseOver="ShowTip(event, 'tt411', 'link426')" onMouseOut="HideTip('tt411')" class=ISymbol>write_config</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/helpers/config_file_helper-php.html#write_db_config" id=link427 onMouseOver="ShowTip(event, 'tt412', 'link427')" onMouseOut="HideTip('tt412')" class=ISymbol>write_db_config</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>$</td><td class=IEntry><a href="../files/core_modules/install/controllers/install-php.html#Install.$writeable_files" id=link428 onMouseOver="ShowTip(event, 'tt413', 'link428')" onMouseOut="HideTip('tt413')" class=ISymbol>writeable_files</a>, <span class=IParent>Install</span></td></tr><tr><td class=IHeading><a name="Y"></a>Y</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/libraries/template-php.html#Template.yield" id=link429 onMouseOver="ShowTip(event, 'tt414', 'link429')" onMouseOut="HideTip('tt414')" class=ISymbol>yield</a>, <span class=IParent>Template</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files2/designers/introduction-txt.html#You've_Got_The_Look" id=link430 onMouseOver="ShowTip(event, 'tt415', 'link430')" onMouseOut="HideTip('tt415')" class=ISymbol>You&rsquo;ve Got The Look</a></td></tr></table>
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt381"><div class=CSection>The UI module holds small helper functions for creating common interface elements. </div></div><div class=CToolTip id="tt382"><div class=CSection>Because security is such a crucial concern with any web application, this document will step you through how authentication works in Bonfire, to make it easy for to determine if it meets the security needs of your application. </div></div><div class=CToolTip id="tt383"><div class=CGeneric>Unit Testing is allows you to write small tests against the code that you write to make sure that everything is functioning as expected. </div></div><div class=CToolTip id="tt384"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public abstract function up()</td></tr></table></blockquote>Abstract method ran when increasing the schema version. </div></div><div class=CToolTip id="tt385"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Updates an existing row in the database.</div></div><div class=CToolTip id="tt386"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function update(</td><td class=PParameter nowrap>$id,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Update a particular permission from the database Remove it from role_permissions if set to inactive</div></div><div class=CToolTip id="tt387"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A simple update of the role. </div></div><div class=CToolTip id="tt388"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update(</td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>array()</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt389"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function update_where(</td><td class=PParameter nowrap>$field</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$data</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>A convenience method that allows you to use any field/value pair as the &lsquo;where&rsquo; portion of your update.</div></div><div class=CToolTip id="tt390"><div class=CSection>To upgrade Bonfire, you simply overwrite the files/folders of the latest version directly over your old files. </div></div><div class=CToolTip id="tt391"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function user_id()</td></tr></table></blockquote>Retrieves the user_id from the current session.</div></div><div class=CToolTip id="tt392"><div class=CClass>The central way to access and perform CRUD on users.</div></div><div class=CToolTip id="tt393"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function user_name()</td></tr></table></blockquote>Retrieves the logged user&rsquo;s name. </div></div><div class=CToolTip id="tt394"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public function username()</td></tr></table></blockquote>Retrieves the username from the current session.</div></div><div class=CToolTip id="tt395"><div class=CClass>Provides front-end functions for users, like login and logout.</div></div><div class=CToolTip id="tt396"><div class=CGeneric><b>Restricting Access to a Module</b></div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt397"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>private function validate_form(</td><td class=PParameter nowrap>$field_total</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Handles the validation of the modulebuilder form.</div></div><div class=CToolTip id="tt398"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function version(</td><td class=PParameter nowrap>$version,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$type</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Migrate to a schema version.</div></div><div class=CToolTip id="tt399"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function view(</td><td class=PParameter nowrap>$file</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>''</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Shows the contents of a single log file.</div></div><div class=CToolTip id="tt400"><div class=CGeneric>When you call the <u>render()</u> method, Bonfire first renders your layout file. </div></div><div class=CToolTip id="tt401"><div class=CGeneric>To view the logs currently on your system, navigate to Developer / Logs. </div></div><div class=CToolTip id="tt402"><div class=CGeneric>You can view all of the emails waiting in your queue by visiting <b>Statistics / Emailer</b> in the Bonfire Admin area. </div></div><div class=CToolTip id="tt403"><div class=CSection>A Layout defines the base look for your website. </div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt404"><div class=CSection>Bonfire helps you build CodeIgniter-based PHP web applications even faster, by providing powerful tools and a beautiful interface you won&rsquo;t be ashamed to show your client.</div></div><div class=CToolTip id="tt405"><div class=CGeneric>A <b>Context</b> is an area of similar responsibility within the code and/or UI. </div></div><div class=CToolTip id="tt406"><div class=CGeneric>At it&rsquo;s heart, Bonfire is nothing more than a pretty interface that can communicate with modules in a pre-determined way. </div></div><div class=CToolTip id="tt407"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function where(</td><td class=PParameter nowrap>$field</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the where portion of the query in a chainable format.</div></div><div class=CToolTip id="tt408"><div class=CGeneric>CodeIgniter&rsquo;s hooks are a great feature, but they don&rsquo;t always provide enough flexibility. </div></div><div class=CToolTip id="tt409"><div class=CGeneric>There are two primary methods that I can see to store the event data: either in the database, or in a file. </div></div><div class=CToolTip id="tt410"><div class=CVariable>An array of folders the installer checks to make sure they can be written to.</div></div><div class=CToolTip id="tt411"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function write_config(</td><td class=PParameter nowrap>$file</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>'',</td></tr><tr><td></td><td class=PParameter nowrap>$settings</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Saves the passed array settings into a single config file located in the /config directory.</div></div><div class=CToolTip id="tt412"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function write_db_config(</td><td class=PParameter nowrap>$settings</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Saves the settings to the config/database.php file.</div></div><div class=CToolTip id="tt413"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>private $writeable_files</td></tr></table></blockquote>An array of files the installer checks to make sure they can be written to.</div></div><!--END_ND_TOOLTIPS-->


<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt414"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static function yield()</td></tr></table></blockquote>Renders the current page into the layout.</div></div><div class=CToolTip id="tt415"><div class=CGeneric>Every web page has a common set of elements that will, typically, wrap the page content. </div></div><!--END_ND_TOOLTIPS-->

</div><!--Index-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MTitle>Bonfire<div class=MSubTitle>Faster CodeIgniter Development</div></div><div class=MEntry><div class=MFile><a href="../files2/welcome-txt.html">Welcome to Bonfire</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Basic Info</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../files2/basic_info/requirements-txt.html">Server Requirements</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/license-txt.html">License Agreement</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/changelog-txt.html">Changelog</a></div></div><div class=MEntry><div class=MFile><a href="../files2/basic_info/credits-txt.html">Credits</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Installation</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../files2/installation/installing-txt.html">Fresh Installation</a></div></div><div class=MEntry><div class=MFile><a href="../files2/installation/troubleshooting-txt.html">Troubleshooting Guide</a></div></div><div class=MEntry><div class=MFile><a href="../files2/installation/upgrading-txt.html">Upgrading</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Introduction</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../files2/introduction/getting_started-txt.html">Getting Started</a></div></div><div class=MEntry><div class=MFile><a href="../files2/introduction/overview-txt.html">Bonfire Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/introduction/concepts-txt.html">Important Concepts</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">General Topics</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../files2/general_topics/ajax-txt.html">AJAX in Bonfire</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/controllers-txt.html">Base Controllers</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/contexts-txt.html">Contexts Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/module_overview-txt.html">Modules Overview</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/application_folder-txt.html">Moving the Application Folder</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/site_areas-txt.html">Site Areas</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/event_hooks-txt.html">System Events</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/auth_notes-txt.html">Understanding Authentication</a></div></div><div class=MEntry><div class=MFile><a href="../files2/general_topics/unit_testing-txt.html">Unit Testing</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Core Modules</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="../files2/core_modules/activities-txt.html">Activities</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/database-txt.html">Database</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/emailer-txt.html">Emailer</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/logs-txt.html">Logs</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/migrations-txt.html">Migrations</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/permissions-txt.html">Permissions</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/roles-txt.html">Roles</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/tester-txt.html">Tester</a></div></div><div class=MEntry><div class=MFile><a href="../files2/core_modules/ui-txt.html">UI</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Designers</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="../files2/designers/introduction-txt.html">Designer Introduction</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/views-txt.html">Views and Layouts</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/blocks-txt.html">Blocks</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/data-txt.html">Dynamic Data</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/flash-txt.html">Flash Messages</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/ajax-txt.html">Handling AJAX</a></div></div><div class=MEntry><div class=MFile><a href="../files2/designers/utilities-txt.html">Template Utility Functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">Tutorials</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="../files3/todo-txt.html">ToDo Module</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Class Reference</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">Core Overrides</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="../files/core/MY_Model-php.html">BF_Model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core/MY_Controller-php.html">Controllers</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">Models</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/models/role_model-php.html">Role_model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/models/role_permission_model-php.html">Role_permission_model</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/permissions/models/permission_model-php.html">Permission_model</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">Helpers</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="../files/helpers/address_helper-php.html">Address Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/application_helper-php.html">Application Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/MY_array_helper-php.html">Array Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/config_file_helper-php.html">Config File Helper</a></div></div><div class=MEntry><div class=MFile><a href="../files/helpers/MY_date_helper-php.html">MY_date_helper</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">Libraries</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="../files/libraries/assets-php.html">Assets</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/Console-php.html">Console</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/events-php.html">Events Class</a></div></div><div class=MEntry><div class=MFile><a href="../files/libraries/template-php.html">Template</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Core Modules</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/models/activity_model-php.html">Activities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">Emailer</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="../files/core_modules/emailer/libraries/emailer-php.html">Emailer Library</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/emailer/controllers/settings-php.html">Emailer Settings Context</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/install/controllers/install-php.html">Install</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/logs/controllers/developer-php.html">Logs Developer Context</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/migrations/libraries/Migrations-php.html">Migrations</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Users</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="../files/core_modules/users/libraries/auth-php.html">Auth Library</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/users/controllers/users-php.html">Users Controller</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/users/models/user_model-php.html">User Model</a></div></div></div></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Bonfire</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Activities</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/controllers/activities-php.html">Activities</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/controllers/reports-php.html">Activities Reports Context</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/assets/js/jquery-dataTables-min-js.html">jquery.<wbr>dataTables.<wbr>min.js</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/activities/views/reports/datatable_js-php.html">views/<wbr>reports/<wbr>datatable_js.php</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/modulebuilder/views/files/controller-php.html">modulebuilder/.../files/<wbr>controller.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/modulebuilder/controllers/developer-php.html">modulebuilder/<wbr>controllers/<wbr>developer.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/roles/controllers/settings-php.html">roles/<wbr>controllers/<wbr>settings.php</a></div></div><div class=MEntry><div class=MFile><a href="../files/core_modules/subnav/controllers/subnav-php.html">subnav/<wbr>controllers/<wbr>subnav.php</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Index</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MIndex id=MSelected>Everything</div></div><div class=MEntry><div class=MIndex><a href="Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="Files.html">Files</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([18], 19);// --></script></div><!--Menu-->


<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>